/*
 * Copyright (c) 2010, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.oracle.js.parser.ir;

// @formatter:off
/**
 * Interface implemented by all nodes that have flags in
 * a lexical context. This is needed as we sometimes have to save
 * the setting of flags in the lexical context until a block
 * is completely finished and its final version (after multiple
 * copy on writes) is placed in the lexical context
 *
 * @param <T> lexical context node that can have flags set during code generation
 */
public interface Flags<T extends LexicalContextNode> {

    /**
     * Get all flags of a LexicalContextNode
     * @return flags
     */
    int getFlags();

    /**
     * Check if a flag is set in a lexical context node
     * @param flag flag to check
     * @return flags
     */
    boolean getFlag(int flag);

    /**
     * Set a flag of a LexicalContextNode
     * @param lc lexical context
     * @param flag flag to set
     * @return the new LexicalContext node if flags were changed, same otherwise
     */
    T setFlag(final LexicalContext lc, int flag);

    /**
     * Set all flags of a LexicalContextNode, overwriting previous flags
     * @param lc lexical context
     * @param flags new flags value
     * @return the new LexicalContext node if flags were changed, same otherwise
     */
    T setFlags(final LexicalContext lc, int flags);
}
